home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / Config / Container / PHPArray.php < prev    next >
PHP Script  |  2004-10-01  |  9KB  |  236 lines
  1. <?php
  2. // +----------------------------------------------------------------------+
  3. // | PHP Version 4                                                        |
  4. // +----------------------------------------------------------------------+
  5. // | Copyright (c) 1997-2003 The PHP Group                                |
  6. // +----------------------------------------------------------------------+
  7. // | This source file is subject to version 2.0 of the PHP license,       |
  8. // | that is bundled with this package in the file LICENSE, and is        |
  9. // | available at through the world-wide-web at                           |
  10. // | http://www.php.net/license/2_02.txt.                                 |
  11. // | If you did not receive a copy of the PHP license and are unable to   |
  12. // | obtain it through the world-wide-web, please send a note to          |
  13. // | license@php.net so we can mail you a copy immediately.               |
  14. // +----------------------------------------------------------------------+
  15. // | Authors: Bertrand Mansion <bmansion@mamasam.com>                     |
  16. // +----------------------------------------------------------------------+
  17. //
  18. // $Id: PHPArray.php,v 1.21 2003/11/29 11:05:34 mansion Exp $
  19.  
  20. /**
  21. * Config parser for common PHP configuration array
  22. * such as found in the horde project.
  23. *
  24. * Options expected is:
  25. * 'name' => 'conf'
  26. * Name of the configuration array.
  27. * Default is $conf[].
  28. * 'useAttr' => true
  29. * Whether we render attributes
  30. *
  31. * @author      Bertrand Mansion <bmansion@mamasam.com>
  32. * @package     Config
  33. */
  34. class Config_Container_PHPArray {
  35.  
  36.     /**
  37.     * This class options:
  38.     * - name of the config array to parse/output
  39.     *   Ex: $options['name'] = 'myconf';
  40.     * - Whether to add attributes to the array
  41.     *   Ex: $options['useAttr'] = false;
  42.     *
  43.     * @var  array
  44.     */
  45.     var $options = array('name' => 'conf',
  46.                          'useAttr' => true);
  47.  
  48.     /**
  49.     * Constructor
  50.     *
  51.     * @access public
  52.     * @param    string  $options    Options to be used by renderer
  53.     */
  54.     function Config_Container_PHPArray($options = array())
  55.     {
  56.         foreach ($options as $key => $value) {
  57.             $this->options[$key] = $value;
  58.         }
  59.     } // end constructor
  60.  
  61.     /**
  62.     * Parses the data of the given configuration file
  63.     *
  64.     * @access public
  65.     * @param string $datasrc    path to the configuration file
  66.     * @param object $obj        reference to a config object
  67.     * @return mixed    returns a PEAR_ERROR, if error occurs or true if ok
  68.     */
  69.     function &parseDatasrc($datasrc, &$obj)
  70.     {
  71.         if (empty($datasrc)) {
  72.             return PEAR::raiseError("Datasource file path is empty.", null, PEAR_ERROR_RETURN);
  73.         }
  74.         if (is_array($datasrc)) {
  75.             $this->_parseArray($datasrc, $obj->container);
  76.         } else {
  77.             if (!file_exists($datasrc)) {
  78.                 return PEAR::raiseError("Datasource file does not exist.", null, PEAR_ERROR_RETURN);        
  79.             } else {
  80.                 include($datasrc);
  81.                 if (!isset(${$this->options['name']}) || !is_array(${$this->options['name']})) {
  82.                     return PEAR::raiseError("File '$datasrc' does not contain a required '".$this->options['name']."' array.", null, PEAR_ERROR_RETURN);
  83.                 }
  84.             }
  85.             $this->_parseArray(${$this->options['name']}, $obj->container);
  86.         }
  87.         return true;
  88.     } // end func parseDatasrc
  89.  
  90.     /**
  91.     * Parses the PHP array recursively
  92.     * @param array  $array      array values from the config file
  93.     * @param object $container  reference to the container object
  94.     * @access private
  95.     * @return void
  96.     */
  97.     function _parseArray($array, &$container)
  98.     {
  99.         foreach ($array as $key => $value) {
  100.             switch ((string)$key) {
  101.                 case '@':
  102.                     $container->setAttributes($value);
  103.                     break;
  104.                 case '#':
  105.                     $container->setType('directive');
  106.                     $container->setContent($value);
  107.                     break;
  108.                 default:
  109.                     if (is_array($value)) {
  110.                         $section =& $container->createSection($key);
  111.                         $this->_parseArray($value, $section);
  112.                     } else {
  113.                         $container->createDirective($key, $value);
  114.                     }
  115.             }
  116.         }
  117.     } // end func _parseArray
  118.  
  119.     /**
  120.     * Returns a formatted string of the object
  121.     * @param    object  $obj    Container object to be output as string
  122.     * @access   public
  123.     * @return   string
  124.     */
  125.     function toString(&$obj)
  126.     {
  127.         if (!isset($string)) {
  128.             $string = '';
  129.         }
  130.         switch ($obj->type) {
  131.             case 'blank':
  132.                 $string .= "\n";
  133.                 break;
  134.             case 'comment':
  135.                 $string .= '// '.$obj->content."\n";
  136.                 break;
  137.             case 'directive':
  138.                 $attrString = '';
  139.                 $parentString = $this->_getParentString($obj);
  140.                 $attributes = $obj->getAttributes();
  141.                 if ($this->options['useAttr'] && is_array($attributes) && count($attributes) > 0) {
  142.                     // Directive with attributes '@' and value '#'
  143.                     $string .= $parentString."['#']";
  144.                     foreach ($attributes as $attr => $val) {
  145.                         $attrString .= $parentString."['@']"
  146.                                     ."['".$attr."'] = '".$val."';\n";
  147.                     }
  148.                 } else {
  149.                     $string .= $parentString;
  150.                 }
  151.                 $string .= ' = ';
  152.                 if (is_string($obj->content)) {
  153.                     $string .= "'".$obj->content."'";
  154.                 } elseif (is_int($obj->content) || is_float($obj->content)) {
  155.                     $string .= $obj->content;
  156.                 } elseif (is_bool($obj->content)) {
  157.                     $string .= ($obj->content) ? 'true' : 'false';
  158.                 }
  159.                 $string .= ";\n";
  160.                 $string .= $attrString;
  161.                 break;
  162.             case 'section':
  163.                 $attrString = '';
  164.                 $attributes = $obj->getAttributes();
  165.                 if ($this->options['useAttr'] && is_array($attributes) && count($attributes) > 0) {
  166.                     $parentString = $this->_getParentString($obj);
  167.                     foreach ($attributes as $attr => $val) {
  168.                         $attrString .= $parentString."['@']"
  169.                                     ."['".$attr."'] = '".$val."';\n";
  170.                     }
  171.                 }
  172.                 $string .= $attrString;
  173.                 if ($count = count($obj->children)) {
  174.                     for ($i = 0; $i < $count; $i++) {
  175.                         $string .= $this->toString($obj->getChild($i));
  176.                     }
  177.                 }
  178.                 break;
  179.             default:
  180.                 $string = '';
  181.         }
  182.         return $string;
  183.     } // end func toString
  184.  
  185.     /**
  186.     * Returns a formatted string of the object parents
  187.     * @access private
  188.     * @return string
  189.     */
  190.     function _getParentString(&$obj)
  191.     {
  192.         $string = '';
  193.         if (!$obj->isRoot()) {
  194.             if (!$obj->parent->isRoot()) {
  195.                 $string = is_int($obj->name) ? "[".$obj->name."]" : "['".$obj->name."']";
  196.             } else {
  197.                 if (empty($this->options['name'])) {
  198.                     $string .= '$'.$obj->name;
  199.                 } else {
  200.                     $string .= '$'.$this->options['name']."['".$obj->name."']";
  201.                 }
  202.             }
  203.             $string = $this->_getParentString($obj->parent).$string;
  204.             $count = $obj->parent->countChildren(null, $obj->name);
  205.             if ($count > 1) {
  206.                 $string .= '['.$obj->getItemPosition().']';
  207.             }
  208.         }
  209.         return $string;
  210.     } // end func _getParentString
  211.  
  212.     /**
  213.     * Writes the configuration to a file
  214.     *
  215.     * @param  mixed  datasrc        info on datasource such as path to the configuraton file
  216.     * @param  string configType     (optional)type of configuration
  217.     * @access public
  218.     * @return string
  219.     */
  220.     function writeDatasrc($datasrc, &$obj)
  221.     {
  222.         $fp = @fopen($datasrc, 'w');
  223.         if ($fp) {
  224.             $string = "<?php\n". $this->toString($obj) ."?>"; // <? : Fix my syntax coloring
  225.             $len = strlen($string);
  226.             @flock($fp, LOCK_EX);
  227.             @fwrite($fp, $string, $len);
  228.             @flock($fp, LOCK_UN);
  229.             @fclose($fp);
  230.             return true;
  231.         } else {
  232.             return PEAR::raiseError('Cannot open datasource for writing.', 1, PEAR_ERROR_RETURN);
  233.         }
  234.     } // end func writeDatasrc
  235. } // end class Config_Container_PHPArray
  236. ?>